IRIX Base Documentation 2002 November

home *** CD-ROM | disk | FTP | other *** search

/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / Xvc / XSGIvcQueryChannelInfo.z / XSGIvcQueryChannelInfo

Wrap

Text File | 2002-10-03 | 15.0 KB | 331 lines

XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyCCCChhhhaaaannnnnnnneeeellllIIIInnnnffffoooo((((3333)))) XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyCCCChhhhaaaannnnnnnneeeellllIIIInnnnffffoooo((((3333)))) NNNNAAAAMMMMEEEE XSGIvcQueryChannelInfo - Query video channel information SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS ####iiiinnnncccclllluuuuddddeeee <<<<XXXX11111111////eeeexxxxtttteeeennnnssssiiiioooonnnnssss////XXXXSSSSGGGGIIIIvvvvcccc....hhhh>>>> SSSSttttaaaattttuuuussss XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyCCCChhhhaaaannnnnnnneeeellllIIIInnnnffffoooo((((DDDDiiiissssppppllllaaaayyyy ****ddddiiiissssppppllllaaaayyyy,,,, iiiinnnntttt ssssccccrrrreeeeeeeennnn,,,, iiiinnnntttt cccchhhhaaaannnnnnnneeeellll,,,, XXXXSSSSGGGGIIIIvvvvccccCCCChhhhaaaannnnnnnneeeellllIIIInnnnffffoooo ********cccciiiinnnnffffoooo____rrrreeeettttuuuurrrrnnnn)))) PPPPAAAARRRRAAAAMMMMEEEETTTTEEEERRRR _d_i_s_p_l_a_y Specifies the connection to the X server. _s_c_r_e_e_n Specifies the screen of the X server. _c_h_a_n_n_e_l The channel number about which information should be returned _c_i_n_f_o__r_e_t_u_r_n A pointer to the XSGIvcChannelInfo variable which is to receive the pointer to the corresponding information. Use XFree to return the memory allocated for this structure. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyCCCChhhhaaaannnnnnnneeeellllIIIInnnnffffoooo returns a structure containing channel information for a specified channel. CCCChhhhaaaannnnnnnneeeellll NNNNuuuummmmbbbbeeeerrrrssss Channel numbers are assigned numbers starting at zero. Subsequent channel numbers increase monotonically by one; thus, each one is unique. Because of this ordering constraint, the channel number may not correspond to physical channel numbers as labeled on the hardware chassis. The _p_h_y_s_i_c_a_l_I_D field of the _X_S_G_I_v_c_C_h_a_n_n_e_l_I_n_f_o structure contains the number of the physical channel. SSSSTTTTRRRRUUUUCCCCTTTTUUUURRRREEEESSSS The XSGIvcChannelInfo contains the following fields: typedef struct { float x, y; float height, width; } XSGIvcRectangle; /* See channelFlags in XSGIvcChannelInfo */ #define XSGIVC_CIFCompositeVideo (1L << 0) /* Composite video output */ #define XSGIVC_CIFPerComponentGain (1L << 1) /* Independent gain adjustment */ Page 1 (printed 10/3/02) XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyCCCChhhhaaaannnnnnnneeeellllIIIInnnnffffoooo((((3333)))) XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyCCCChhhhaaaannnnnnnneeeellllIIIInnnnffffoooo((((3333)))) typedef struct { Bool active; /* channel is operating */ XSGIvcRectangle source; /* Position on display surface */ XSGIvcVideoFormatInfo vfinfo; /* Video format details */ long channelFlags; /* See XSGIVC_CIF... masks */ int *gammaMaps; /* Assignable gamma maps (ptr to array) */ int gammaCount; /* Returned count of gammaMaps */ Bool blankingOp; /* XSGIvcSetOutputBlanking usable */ Bool gainOp; /* XSGIvcSetOutputGain usable */ Bool pedestalOp; /* XSGIvcSetOutputPedestal usable */ Bool phaseHOp; /* XSGIvcSetOutputPhaseH usable */ int phaseHMin; /* Range of OutputPhaseH */ int phaseHMax; Bool phaseVOp; /* XSGIvcSetOutputPhaseV usable */ int phaseVMin; /* Range of OutputPhaseV */ int phaseVMax; Bool phaseSCHOp; /* XSGIvcSetOutputPhaseSCH usable */ int phaseSCHMin; /* Range of OutputPhaseSCH */ int phaseSCHMax; Bool syncOp; /* XSGIvcSetOutputSync usable */ int syncPortCount; /* Number of sync ports */ XSGIvcChannelSyncInfo *syncInfo; /* Information on all sync ports */ int physicalID; /* Physical port */ } XSGIvcChannelInfo; /* Used in XSGIvcChannelInfo structure */ typedef struct { int syncPort; /* One of XSGIVC_SP... values */ int *syncTypeList; /* The list of XSGIVC_SF... */ int syncTypeListCount; /* Count of items in syncTypeList */ } XSGIvcChannelSyncInfo; In the XSGIvcChannelInfo structure, the fields are defined in the following manner: _a_c_t_i_v_e field is TRUE if the queried channel is operational. Servers with multiple channels may be programmed to run only some of the output channels. If the value of this field is FALSE, the remaining fields in the structure are undefined. _s_o_u_r_c_e is a XSGIvcRectangle structure that contains the portion of the frame buffer that this channel displays. The XSGIvcRectangle structure describes a rectangle whose origin is at _x,_y and whose size is described by _h_e_i_g_h_t and _w_i_d_t_h. On graphics hardware platforms with only one channel, this source rectangle is frequently the entire managed area of the Screen. However, on Page 2 (printed 10/3/02) XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyCCCChhhhaaaannnnnnnneeeellllIIIInnnnffffoooo((((3333)))) XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyCCCChhhhaaaannnnnnnneeeellllIIIInnnnffffoooo((((3333)))) graphics hardware platforms that have more than one channel for output, each channel may display a different portion of the frame buffer. _v_f_i_n_f_o contains the detailed information that describes the video format. This information is valid only if _a_c_t_i_v_e is true. _c_h_a_n_n_e_l_F_l_a_g_s is a set of flags that indicates information about the channel. _g_a_m_m_a_M_a_p_s is an array of items, each item contains the index of a gamma map which may be assigned to this channel. The number of items is returned in _g_a_m_m_a_C_o_u_n_t. _b_l_a_n_k_i_n_g_O_p is TRUE if the operations of the function XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttOOOOuuuuttttppppuuuuttttBBBBllllaaaannnnkkkkiiiinnnngggg are supported on this channel. _g_a_i_n_O_p is TRUE if the operations of the function XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttOOOOuuuuttttppppuuuuttttGGGGaaaaiiiinnnn are supported on this channel. _p_h_a_s_e_H_M_i_n_R_e_t_u_r_n Returns the minimum value to which horizontal phase may be set. _p_h_a_s_e_H_M_a_x_R_e_t_u_r_n Returns the maximum value to which horizontal phase may be set. _p_h_a_s_e_V_M_i_n_R_e_t_u_r_n Returns the minimum value to which vertical phase may be set. _p_h_a_s_e_V_M_a_x_R_e_t_u_r_n Returns the maximum value to which vertical phase may be set. Page 3 (printed 10/3/02) XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyCCCChhhhaaaannnnnnnneeeellllIIIInnnnffffoooo((((3333)))) XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyCCCChhhhaaaannnnnnnneeeellllIIIInnnnffffoooo((((3333)))) _p_h_a_s_e_S_C_H_M_i_n_R_e_t_u_r_n Returns the minimum value to which SCH phase may be set. _p_h_a_s_e_S_C_H_M_a_x_R_e_t_u_r_n Returns the maximum value to which SCH phase may be set. _s_y_n_c_O_p Operations to set output sync are permitted on this channel. See the function XXXXSSSSGGGGIIIIvvvvccccSSSSeeeettttOOOOuuuuttttppppuuuuttttSSSSyyyynnnncccc. _s_y_n_c_P_o_r_t_C_o_u_n_t is the number of sync ports available for this channel. This count includes the standard sync ports of _X_S_G_I_V_C__S_P_R_e_d, _X_S_G_I_V_C__S_P_G_r_e_e_n, _X_S_G_I_V_C__S_P_B_l_u_e, and _X_S_G_I_V_C__S_P_A_l_p_h_a (if the ports are present and their output can be altered) as well as the auxiliary ports. _s_y_n_c_I_n_f_o This is a pointer to an array of XSGIvcChannelSyncInfo structures. Each channel may have zero, one or more sync ports for which the sync may be altered; each mutable sync port is represented by one XSGIvcChannelSyncInfo structure in the array. There are _s_y_n_c_P_o_r_t_C_o_u_n_t items in the array. All ports which can have its sync characteristics altered are included. See below for a description of each of the fields. _p_h_y_s_i_c_a_l_I_D This identifies the physical port number of this channel. This is the number as labeled on the chassis or cable of the video output. Servers may take liberties in numbering output ports which are not strictly numbered (e.g., an encoder channel) such as using negative numbers or impossibly high numbers. This value is to be used only as a correlation to chassis number; you should use the other values in this structure to determine characteristics instead of relying on some special decoding of physical channel number. In the XSGIvcChannelSyncInfo structure, the fields are defined in the following manner: Page 4 (printed 10/3/02) XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyCCCChhhhaaaannnnnnnneeeellllIIIInnnnffffoooo((((3333)))) XXXXSSSSGGGGIIIIvvvvccccQQQQuuuueeeerrrryyyyCCCChhhhaaaannnnnnnneeeellllIIIInnnnffffoooo((((3333)))) _s_y_n_c_P_o_r_t Identifies the sync port. This can be one of the standard color components of _X_S_G_I_V_C__S_P_R_e_d, _X_S_G_I_V_C__S_P_G_r_e_e_n, _X_S_G_I_V_C__S_P_B_l_u_e, and _X_S_G_I_V_C__S_P_A_l_p_h_a; these values are all defined with negative numbers. Alternatively, this idenfier can refer to one of the auxiliary sync ports; the auxiliary sync ports are numbered increasingly from zero (0) and can be also identified using the constants _X_S_G_I_V_C__S_P_A_u_x_0, _X_S_G_I_V_C__S_P_A_u_x_1, and _X_S_G_I_V_C__S_P_A_u_x_2. _s_y_n_c_T_y_p_e_L_i_s_t This is a pointer to an array of items defined as int. Each item represents one of the different sync output modes to which this sync port can be set, and contains one of: _X_S_G_I_V_C__N_o_n_e, _X_S_G_I_V_C__S_F_H_o_r_i_z_o_n_t_a_l_V_i_d_e_o, _X_S_G_I_V_C__S_F_V_e_r_t_i_c_a_l_V_i_d_e_o, _X_S_G_I_V_C__S_F_C_o_m_p_o_s_i_t_e_V_i_d_e_o, _X_S_G_I_V_C__S_F_H_o_r_i_z_o_n_t_a_l_T_T_L, _X_S_G_I_V_C__S_F_V_e_r_t_i_c_a_l_T_T_L, _X_S_G_I_V_C__S_F_C_o_m_p_o_s_i_t_e_T_T_L, _X_S_G_I_V_C__S_F_H_o_r_i_z_o_n_t_a_l_T_r_i_L_e_v_e_l, _X_S_G_I_V_C__S_F_V_e_r_t_i_c_a_l_T_r_i_L_e_v_e_l, or _X_S_G_I_V_C__S_F_C_o_m_p_o_s_i_t_e_T_r_i_L_e_v_e_l. _s_y_n_c_T_y_p_e_L_i_s_t_C_o_u_n_t The number of items in the _s_y_n_c_T_y_p_e_L_i_s_t array. RRRREEEETTTTUUUURRRRNNNN VVVVAAAALLLLUUUUEEEE This function returns TRUE if successful , FALSE upon failure. Parameter errors are reported via BadValue or BadMatch. SSSSEEEEEEEE AAAALLLLSSSSOOOO XSGIvc , XSGIvcListVideoFormats , XSGIvcSetChannelGammaMap Page 5 (printed 10/3/02)